home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / slaebz.z / slaebz
Text File  |  1996-03-14  |  12KB  |  265 lines
  1.  
  2.  
  3.  
  4. SSSSLLLLAAAAEEEEBBBBZZZZ((((3333FFFF))))                                                          SSSSLLLLAAAAEEEEBBBBZZZZ((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SLAEBZ - contain the iteration loops which compute and use the function
  10.      N(w), which is the count of eigenvalues of a symmetric tridiagonal matrix
  11.      T less than or equal to its argument w
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE SLAEBZ( IJOB, NITMAX, N, MMAX, MINP, NBMIN, ABSTOL, RELTOL,
  15.                         PIVMIN, D, E, E2, NVAL, AB, C, MOUT, NAB, WORK, IWORK,
  16.                         INFO )
  17.  
  18.          INTEGER        IJOB, INFO, MINP, MMAX, MOUT, N, NBMIN, NITMAX
  19.  
  20.          REAL           ABSTOL, PIVMIN, RELTOL
  21.  
  22.          INTEGER        IWORK( * ), NAB( MMAX, * ), NVAL( * )
  23.  
  24.          REAL           AB( MMAX, * ), C( * ), D( * ), E( * ), E2( * ), WORK(
  25.                         * )
  26.  
  27. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  28.      SLAEBZ contains the iteration loops which compute and use the function
  29.      N(w), which is the count of eigenvalues of a symmetric tridiagonal matrix
  30.      T less than or equal to its argument  w.  It performs a choice of two
  31.      types of loops:
  32.  
  33.      IJOB=1, followed by
  34.      IJOB=2: It takes as input a list of intervals and returns a list of
  35.              sufficiently small intervals whose union contains the same
  36.              eigenvalues as the union of the original intervals.
  37.              The input intervals are (AB(j,1),AB(j,2)], j=1,...,MINP.
  38.              The output interval (AB(j,1),AB(j,2)] will contain
  39.              eigenvalues NAB(j,1)+1,...,NAB(j,2), where 1 <= j <= MOUT.
  40.  
  41.      IJOB=3: It performs a binary search in each input interval
  42.              (AB(j,1),AB(j,2)] for a point  w(j)  such that
  43.              N(w(j))=NVAL(j), and uses  C(j)  as the starting point of
  44.              the search.  If such a w(j) is found, then on output
  45.              AB(j,1)=AB(j,2)=w.  If no such w(j) is found, then on output
  46.              (AB(j,1),AB(j,2)] will be a small interval containing the
  47.              point where N(w) jumps through NVAL(j), unless that point
  48.              lies outside the initial interval.
  49.  
  50.      Note that the intervals are in all cases half-open intervals, i.e., of
  51.      the form  (a,b] , which includes  b  but not  a .
  52.  
  53.      To avoid underflow, the matrix should be scaled so that its largest
  54.      element is no greater than  overflow**(1/2) * underflow**(1/4) in
  55.      absolute value.  To assure the most accurate computation of small
  56.      eigenvalues, the matrix should be scaled to be
  57.      not much smaller than that, either.
  58.  
  59.      See W. Kahan "Accurate Eigenvalues of a Symmetric Tridiagonal Matrix",
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSLLLLAAAAEEEEBBBBZZZZ((((3333FFFF))))                                                          SSSSLLLLAAAAEEEEBBBBZZZZ((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      Report CS41, Computer Science Dept., Stanford
  75.      University, July 21, 1966
  76.  
  77.      Note: the arguments are, in general, *not* checked for unreasonable
  78.      values.
  79.  
  80.  
  81. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  82.      IJOB    (input) INTEGER
  83.              Specifies what is to be done:
  84.              = 1:  Compute NAB for the initial intervals.
  85.              = 2:  Perform bisection iteration to find eigenvalues of T.
  86.              = 3:  Perform bisection iteration to invert N(w), i.e., to find a
  87.              point which has a specified number of eigenvalues of T to its
  88.              left.  Other values will cause SLAEBZ to return with INFO=-1.
  89.  
  90.      NITMAX  (input) INTEGER
  91.              The maximum number of "levels" of bisection to be performed,
  92.              i.e., an interval of width W will not be made smaller than 2^(-
  93.              NITMAX) * W.  If not all intervals have converged after NITMAX
  94.              iterations, then INFO is set to the number of non-converged
  95.              intervals.
  96.  
  97.      N       (input) INTEGER
  98.              The dimension n of the tridiagonal matrix T.  It must be at least
  99.              1.
  100.  
  101.      MMAX    (input) INTEGER
  102.              The maximum number of intervals.  If more than MMAX intervals are
  103.              generated, then SLAEBZ will quit with INFO=MMAX+1.
  104.  
  105.      MINP    (input) INTEGER
  106.              The initial number of intervals.  It may not be greater than
  107.              MMAX.
  108.  
  109.      NBMIN   (input) INTEGER
  110.              The smallest number of intervals that should be processed using a
  111.              vector loop.  If zero, then only the scalar loop will be used.
  112.  
  113.      ABSTOL  (input) REAL
  114.              The minimum (absolute) width of an interval.  When an interval is
  115.              narrower than ABSTOL, or than RELTOL times the larger (in
  116.              magnitude) endpoint, then it is considered to be sufficiently
  117.              small, i.e., converged.  This must be at least zero.
  118.  
  119.      RELTOL  (input) REAL
  120.              The minimum relative width of an interval.  When an interval is
  121.              narrower than ABSTOL, or than RELTOL times the larger (in
  122.              magnitude) endpoint, then it is considered to be sufficiently
  123.              small, i.e., converged.  Note: this should always be at least
  124.              radix*machine epsilon.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSLLLLAAAAEEEEBBBBZZZZ((((3333FFFF))))                                                          SSSSLLLLAAAAEEEEBBBBZZZZ((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      PIVMIN  (input) REAL
  141.              The minimum absolute value of a "pivot" in the Sturm sequence
  142.              loop.  This *must* be at least  max |e(j)**2| * safe_min  and at
  143.              least safe_min, where safe_min is at least the smallest number
  144.              that can divide one without overflow.
  145.  
  146.      D       (input) REAL array, dimension (N)
  147.              The diagonal elements of the tridiagonal matrix T.
  148.  
  149.      E       (input) REAL array, dimension (N)
  150.              The offdiagonal elements of the tridiagonal matrix T in positions
  151.              1 through N-1.  E(N) is arbitrary.
  152.  
  153.      E2      (input) REAL array, dimension (N)
  154.              The squares of the offdiagonal elements of the tridiagonal matrix
  155.              T.  E2(N) is ignored.
  156.  
  157.      NVAL    (input/output) INTEGER array, dimension (MINP)
  158.              If IJOB=1 or 2, not referenced.  If IJOB=3, the desired values of
  159.              N(w).  The elements of NVAL will be reordered to correspond with
  160.              the intervals in AB.  Thus, NVAL(j) on output will not, in
  161.              general be the same as NVAL(j) on input, but it will correspond
  162.              with the interval (AB(j,1),AB(j,2)] on output.
  163.  
  164.      AB      (input/output) REAL array, dimension (MMAX,2)
  165.              The endpoints of the intervals.  AB(j,1) is  a(j), the left
  166.              endpoint of the j-th interval, and AB(j,2) is b(j), the right
  167.              endpoint of the j-th interval.  The input intervals will, in
  168.              general, be modified, split, and reordered by the calculation.
  169.  
  170.      C       (input/output) REAL array, dimension (MMAX)
  171.              If IJOB=1, ignored.  If IJOB=2, workspace.  If IJOB=3, then on
  172.              input C(j) should be initialized to the first search point in the
  173.              binary search.
  174.  
  175.      MOUT    (output) INTEGER
  176.              If IJOB=1, the number of eigenvalues in the intervals.  If IJOB=2
  177.              or 3, the number of intervals output.  If IJOB=3, MOUT will equal
  178.              MINP.
  179.  
  180.      NAB     (input/output) INTEGER array, dimension (MMAX,2)
  181.              If IJOB=1, then on output NAB(i,j) will be set to N(AB(i,j)).  If
  182.              IJOB=2, then on input, NAB(i,j) should be set.  It must satisfy
  183.              the condition:  N(AB(i,1)) <= NAB(i,1) <= NAB(i,2) <= N(AB(i,2)),
  184.              which means that in interval i only eigenvalues
  185.              NAB(i,1)+1,...,NAB(i,2) will be considered.  Usually,
  186.              NAB(i,j)=N(AB(i,j)), from a previous call to SLAEBZ with IJOB=1.
  187.              On output, NAB(i,j) will contain
  188.              max(na(k),min(nb(k),N(AB(i,j)))), where k is the index of the
  189.              input interval that the output interval (AB(j,1),AB(j,2)] came
  190.              from, and na(k) and nb(k) are the the input values of NAB(k,1)
  191.              and NAB(k,2).  If IJOB=3, then on output, NAB(i,j) contains
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSLLLLAAAAEEEEBBBBZZZZ((((3333FFFF))))                                                          SSSSLLLLAAAAEEEEBBBBZZZZ((((3333FFFF))))
  203.  
  204.  
  205.  
  206.              N(AB(i,j)), unless N(w) > NVAL(i) for all search points  w , in
  207.              which case NAB(i,1) will not be modified, i.e., the output value
  208.              will be the same as the input value (modulo reorderings -- see
  209.              NVAL and AB), or unless N(w) < NVAL(i) for all search points  w ,
  210.              in which case NAB(i,2) will not be modified.  Normally, NAB
  211.              should be set to some distinctive value(s) before SLAEBZ is
  212.              called.
  213.  
  214.      WORK    (workspace) REAL array, dimension (MMAX)
  215.              Workspace.
  216.  
  217.      IWORK   (workspace) INTEGER array, dimension (MMAX)
  218.              Workspace.
  219.  
  220.      INFO    (output) INTEGER
  221.              = 0:       All intervals converged.
  222.              = 1--MMAX: The last INFO intervals did not converge.
  223.              = MMAX+1:  More than MMAX intervals were generated.
  224.  
  225. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  226.          This routine is intended to be called only by other LAPACK routines,
  227.      thus the interface is less user-friendly.  It is intended for two
  228.      purposes:
  229.  
  230.      (a) finding eigenvalues.  In this case, SLAEBZ should have one or
  231.          more initial intervals set up in AB, and SLAEBZ should be called
  232.          with IJOB=1.  This sets up NAB, and also counts the eigenvalues.
  233.          Intervals with no eigenvalues would usually be thrown out at
  234.          this point.  Also, if not all the eigenvalues in an interval i
  235.          are desired, NAB(i,1) can be increased or NAB(i,2) decreased.
  236.          For example, set NAB(i,1)=NAB(i,2)-1 to get the largest
  237.          eigenvalue.  SLAEBZ is then called with IJOB=2 and MMAX
  238.          no smaller than the value of MOUT returned by the call with
  239.          IJOB=1.  After this (IJOB=2) call, eigenvalues NAB(i,1)+1
  240.          through NAB(i,2) are approximately AB(i,1) (or AB(i,2)) to the
  241.          tolerance specified by ABSTOL and RELTOL.
  242.  
  243.      (b) finding an interval (a',b'] containing eigenvalues w(f),...,w(l).
  244.          In this case, start with a Gershgorin interval  (a,b).  Set up
  245.          AB to contain 2 search intervals, both initially (a,b).  One
  246.          NVAL element should contain  f-1  and the other should contain  l
  247.          , while C should contain a and b, resp.  NAB(i,1) should be -1
  248.          and NAB(i,2) should be N+1, to flag an error if the desired
  249.          interval does not lie in (a,b).  SLAEBZ is then called with
  250.          IJOB=3.  On exit, if w(f-1) < w(f), then one of the intervals --
  251.          j -- will have AB(j,1)=AB(j,2) and NAB(j,1)=NAB(j,2)=f-1, while
  252.          if, to the specified tolerance, w(f-k)=...=w(f+r), k > 0 and r
  253.          >= 0, then the interval will have  N(AB(j,1))=NAB(j,1)=f-k and
  254.          N(AB(j,2))=NAB(j,2)=f+r.  The cases w(l) < w(l+1) and
  255.          w(l-r)=...=w(l+k) are handled similarly.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.